Skip to content

Add monitoring integrations reference documentation#229

Merged
mwarkentin merged 1 commit intomainfrom
michaelwarkentin/docs/caller-guide
Mar 8, 2026
Merged

Add monitoring integrations reference documentation#229
mwarkentin merged 1 commit intomainfrom
michaelwarkentin/docs/caller-guide

Conversation

@mwarkentin
Copy link
Owner

@mwarkentin mwarkentin commented Mar 8, 2026

Summary

  • Adds a new reference doc (docs/reference/monitoring-integrations.md) describing how external uptime monitoring services consume django-watchman's health-check endpoints
  • Covers 9 vendors (alphabetically): Better Stack, Cronitor, Datadog Synthetics, Panopta, Pingdom, StatusCake, updown.io, Upptime, and UptimeRobot
  • Each vendor section follows a consistent structure: description, recommended endpoint, authentication, response interpretation, and vendor documentation link
  • Groups the existing API reference and the new page under a "Reference" nav section in mkdocs

Closes #97

Test plan

  • Run mkdocs build --strict and verify no warnings or errors
  • Run mkdocs serve and verify the new page renders correctly under Reference > Monitoring Integrations
  • Verify all external vendor documentation links resolve

Made with Cursor

@mwarkentin mwarkentin force-pushed the michaelwarkentin/docs/caller-guide branch 3 times, most recently from da22f64 to b96823d Compare March 8, 2026 02:29
Document how django-watchman's endpoints are consumed by common uptime
monitoring vendors, helping newcomers understand the "calling side" of
the health-check flow.

Closes #97

Made-with: Cursor
@mwarkentin mwarkentin force-pushed the michaelwarkentin/docs/caller-guide branch from b96823d to ada9b00 Compare March 8, 2026 02:31
@mwarkentin mwarkentin merged commit 9372a5d into main Mar 8, 2026
19 checks passed
@mwarkentin mwarkentin deleted the michaelwarkentin/docs/caller-guide branch March 8, 2026 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs for new comers: Calling side of django-watchman

1 participant